StringListParameter Class Reference
[VST Implementation Helper Classes]

Description of a StringListParameter. More...

#include <vstparameters.h>

Inheritance diagram for StringListParameter:
Inheritance graph
[legend]

Public Member Functions

 StringListParameter (const ParameterInfo &paramInfo)
 StringListParameter (const TChar *title, ParamID tag, const TChar *units=0, int32 flags=ParameterInfo::kCanAutomate|ParameterInfo::kIsList, UnitID unitID=kRootUnitId)
virtual ~StringListParameter ()
virtual void appendString (const String128 string)
 Appends a string and increases the stepCount.
virtual bool replaceString (int32 index, const String128 string)
 Replaces the string at index.
virtual void toString (ParamValue valueNormalized, String128 string) const
 Converts a normalized value to a string.
virtual bool fromString (const TChar *string, ParamValue &valueNormalized) const
 Converts a string to a normalized value.
virtual ParamValue toPlain (ParamValue valueNormalized) const
 Converts a normalized value to plain value (e.g.
virtual ParamValue toNormalized (ParamValue plainValue) const
 Converts a plain value to a normalized value (e.g.

Detailed Description

Description of a StringListParameter.


Constructor & Destructor Documentation

StringListParameter ( const ParameterInfo paramInfo  ) 
StringListParameter ( const TChar title,
ParamID  tag,
const TChar units = 0,
int32  flags = ParameterInfo::kCanAutomate | ParameterInfo::kIsList,
UnitID  unitID = kRootUnitId 
)
~StringListParameter (  )  [virtual]

Member Function Documentation

void appendString ( const String128  string  )  [virtual]

Appends a string and increases the stepCount.

bool replaceString ( int32  index,
const String128  string 
) [virtual]

Replaces the string at index.

Index must be between 0 and stepCount+1

void toString ( ParamValue  valueNormalized,
String128  string 
) const [virtual]

Converts a normalized value to a string.

Reimplemented from Parameter.

bool fromString ( const TChar string,
ParamValue valueNormalized 
) const [virtual]

Converts a string to a normalized value.

Reimplemented from Parameter.

ParamValue toPlain ( ParamValue  valueNormalized  )  const [virtual]

Converts a normalized value to plain value (e.g.

0.5 to 10000.0Hz).

Reimplemented from Parameter.

ParamValue toNormalized ( ParamValue  plainValue  )  const [virtual]

Converts a plain value to a normalized value (e.g.

10000 to 0.5).

Reimplemented from Parameter.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.